Document Linkify match options - #544
Conversation
Refs #186 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the XML documentation for Android.Text.Util.MatchOptions by replacing placeholder summaries with descriptive text for the Linkify-related flag values, aligning the docs with the Android Linkify reference.
Changes:
- Documented the
EmailAddressesmatch option (bit-field flag). - Documented the
PhoneNumbersmatch option (bit-field flag). - Documented the
WebUrlsmatch option (bit-field flag).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@dalexsoto review |
1 similar comment
|
@dalexsoto review |
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
All and MapAddresses remain undocumented even though both are public flags with important deprecated behavior. All includes MapAddresses, whose upstream implementation has documented limitations and can throw on Android 8.1 and earlier, while the managed fields have no [Obsolete] warning. Please document their composition, deprecation, and avoidance guidance in publishing-supported content: MatchOptions.xml.
Refs #186 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: aac317fb-e820-4251-a4cf-99af9e32bd38
|
@dalexsoto Addressed the requested documentation: |
|
@dalexsoto review |
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
The All and MapAddresses summaries now cover composition and basic status, but all deprecation, avoidance, WebView limitation, and Android 8.1 exception guidance is still placed in enum-field <remarks>, which ECMA2Yaml ignores. Please move the essential warnings into published member summaries or type-level remarks and verify the generated preview: MatchOptions.xml.
Refs #186 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: aac317fb-e820-4251-a4cf-99af9e32bd38
|
@dalexsoto Addressed the publishing-surface feedback in commit |
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
The warnings now publish, but their text uses Java APIs (TextClassifier.generateLinks, WebView.findAddress) instead of managed ITextClassifier.GenerateLinks and WebView.FindAddress, and says "methods in this class" although the class is MatchOptions rather than Linkify. GenerateLinks is also API 28+, so it is unavailable on the API 27-and-earlier path discussed. Please use managed crefs, identify Linkify explicitly, and retain valid older-platform guidance.
Refs #186 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: aac317fb-e820-4251-a4cf-99af9e32bd38
|
@dalexsoto Addressed the wording feedback in commit |
|
@dalexsoto review |
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
The MatchOptions warnings now publish with correct managed crefs, Linkify context, API-level guidance, and older-platform limitations.
Refs #186
Sources
Linkifyreference: Linkify mask behavior and the Android 8.1-and-earlier WebView-update exception note.Linkify.java:ALLcomposition and Android deprecation/avoidance guidance forALLandMAP_ADDRESSES.Validation
docs/xml/Android.Text.Util/MatchOptions.xmlwith PowerShell's XML parser.git diff --check.AllandMapAddressessummaries use managedITextClassifier.GenerateLinks,WebView.FindAddress, andLinkifyxrefs; no Java-form API prose remains.